-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding dump file #25
Adding dump file #25
Conversation
include metadata in crash dumps.
Turns this repository into a cargo workspaces and adds a sub-crate with the wonderful name 'simple-human-panic-test' that lives in the new `tests/` directory. This should be of no consequence to the actual crate itself or its deployment to crates.io, but allows us to easily test how human-panic works when in an external crate. Especially, we can set up the sub-crate `Cargo.toml` files in a way that we can easily test that human-panic's output does not cause panics in humans. For that, I've also added a simple integration test to the `simple` test crate. It uses assert_cli to run the crate's main binary and assert its output contains certain strings (as well as that it exits with a panic- typical exit code). By the way: One benefit of using cargo workspaces is that sub-crates share a lock file and a `target/` directory. So, we can add lots of test crates without worrying of having to recompile dependencies all the time. You can easily run the tests across all sub-crates with `cargo test --all`. In general, most cargo subcommands support `--all`, and I've added it in a few places in the CI config.
for great ~~justice~~ formatting
And in true me fashion I broke the CI in my first attempt 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM after rebase and with toml code block flag
backtrace = ''' | ||
stack backtrace: | ||
0: 0x55fa0ed4c1b4 - backtrace::backtrace::libunwind::trace::h69e50feca54bfb84 | ||
at /home/spacekookie/.cargo/registry/src/github.com-1ecc6299db9ec823/backtrace-0.3.6/src/backtrace/libunwind.rs:53 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't reproduce this output locally, it says /Users/pascal/.cargo/…
on my machine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh Pascal.... 😅
README.md
Outdated
@@ -46,6 +46,49 @@ We take privacy seriously, and do not perform any automated error collection. In | |||
Thank you kindly! | |||
``` | |||
|
|||
The error dump file generated by `human-panic` contains the following fields. | |||
|
|||
```norun |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rustdoc assumes code to be rust
(makes sense), so instead of norun
you should probably set it to toml
which would be more correct and more highlighted on github
#26 was merged instead |
This is a 🔦 documentation change.
Simply add an example dump file to the README ✨
Based of #24
Checklist
Context
This PR should address #23
Semver Changes
Bump patch